xet-data 1.5.2

Data processing pipeline for chunking, deduplication, and file reconstruction; used in the Hugging Face Xet client tools. Intended to be used through the API in the hf-xet package.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
\origin unavailable
\textclass article
\use_default_options true
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
\use_dash_ligatures true
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\use_hyperref false
\papersize default
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 1
\use_minted 0
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\is_math_indent 0
\math_numbering_side default
\quotes_style english
\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header

\begin_body

\begin_layout Title
Parallel Chunking
\end_layout

\begin_layout Author
Yucheng Low
\end_layout

\begin_layout Section
Content Defined Chunking
\end_layout

\begin_layout Standard
The basic principle of Content Defined Chunking (CDC) is to split a file
 into smaller chunks, produce variable sized-chunks, that are mostly stable
 to insertions and deletions.
 This is as opposed to fixed-size chunking where a file is split into constant
 sized chunks where insertions/deletions which are not exactly chunk aligned
 will cause all remaining chunks to be modified.
 Content defined chunking is excellent at data duplication as files with
 similar contents (for instance two neural network models stored as different
 file formats) can deduplicate against each other effectively.
 
\end_layout

\begin_layout Standard
We will not go too deep into implementation and usage of content defined
 chunking here.
 We recommend reading the GearHash paper, or our prior paper Git is for
 Data for a more detailed description.
 A challenge with CDC is that due to the variable block sizes, it is generally
 necessary to start chunking from the start of the file.
 However, this can be a performance issue with very large files in which
 the CDC procedure can be a bottleneck and that is what we will like to
 address in this paper.
\end_layout

\begin_layout Standard
Instead of assuming any particular chunking procedure, we will just rely
 on a simplified formal description.
 Given a determinstic rolling hash function 
\begin_inset Formula $H(x)\rightarrow\{0,1\}$
\end_inset

 which accepts a short string of length 
\begin_inset Formula $k$
\end_inset

 and returns an boolean.
 Given a string 
\begin_inset Formula $S$
\end_inset

.
 The basic CDC procedure works as follows:
\end_layout

\begin_layout LyX-Code
ChunkStart = 0
\end_layout

\begin_layout LyX-Code
for 
\begin_inset Formula $i$
\end_inset

 in [0, 
\begin_inset Formula $|S|-k$
\end_inset

):
\end_layout

\begin_deeper
\begin_layout LyX-Code
if H(file[
\begin_inset Formula $i$
\end_inset

...
\begin_inset Formula $i+k$
\end_inset

]) == 1:
\end_layout

\begin_deeper
\begin_layout LyX-Code
AddChunk(file[ChunkStart...
\begin_inset Formula $i$
\end_inset

])
\end_layout

\begin_layout LyX-Code
ChunkStart = 
\begin_inset Formula $i$
\end_inset


\end_layout

\end_deeper
\end_deeper
\begin_layout LyX-Code
AddChunk(file[ChunkStart...])
\end_layout

\begin_layout Standard
A minimum (
\begin_inset Formula $m$
\end_inset

) and maximum (
\begin_inset Formula $M$
\end_inset

) chunk size is normally used to avoid too tiny and overly large chunks:
\end_layout

\begin_layout LyX-Code
ChunkStart = 0
\end_layout

\begin_layout LyX-Code
for 
\begin_inset Formula $i$
\end_inset

 in [0, 
\begin_inset Formula $|S|-k$
\end_inset

)):
\end_layout

\begin_deeper
\begin_layout LyX-Code
if (
\begin_inset Formula $i$
\end_inset

 - ChunkStart 
\begin_inset Formula $\ge M$
\end_inset

) or (H(file[
\begin_inset Formula $i$
\end_inset

...
\begin_inset Formula $i+k$
\end_inset

]) == 1 and 
\begin_inset Formula $i$
\end_inset

 - ChunkStart 
\begin_inset Formula $\ge m$
\end_inset

):
\end_layout

\begin_deeper
\begin_layout LyX-Code
AddChunk(file[ChunkStart\SpecialChar endofsentence
..
\begin_inset Formula $i$
\end_inset

])
\end_layout

\begin_layout LyX-Code
ChunkStart = 
\begin_inset Formula $i$
\end_inset


\end_layout

\end_deeper
\end_deeper
\begin_layout LyX-Code
AddChunk(file[ChunkStart...])
\end_layout

\begin_layout Standard
(Note that this simplified formulation does not cover more advanced procedures
 like the low variance chunking method in the Git Is for Data Paper,
 nor the adaptive chunking method in FastCDC).
\end_layout

\begin_layout Standard
The goal is to find conditions in which we can 
\begin_inset Quotes eld
\end_inset

seek
\begin_inset Quotes erd
\end_inset

 into an arbitrary location 
\begin_inset Formula $|S|$
\end_inset

 and find a set of chunks that are guaranteed to align with chunks produced
 by starting from the beginning of the file with the basic CDC procedure
 above.
\end_layout

\begin_layout Section
Parallel Chunking
\end_layout

\begin_layout Standard
Consider two threads, first thread beginning chunking from 
\begin_inset Formula $S[0]$
\end_inset

 and second thread beginning chunking from an arbitrary location.
 
\end_layout

\begin_layout Standard
Under what condition will the chunks produced by thread 2 be gauranteed
 to line up with the chunks produced by thread 1?
\end_layout

\begin_layout Standard
Assume that second thread finds 3 consecutive chunk boundaries 
\begin_inset Formula $c_{0},c_{1}$
\end_inset

 and 
\begin_inset Formula $c_{2}$
\end_inset

 with the following conditions:
\end_layout

\begin_layout Enumerate
The chunk sizes are not 
\begin_inset Quotes eld
\end_inset

near
\begin_inset Quotes erd
\end_inset

 the chunk size limits: 
\begin_inset Formula $m<c_{1}-c_{0}\le M-m$
\end_inset

 and 
\begin_inset Formula $m<c_{2}-c_{1}\le M-m$
\end_inset

.
 
\end_layout

\begin_layout Enumerate
There is no other chunk boundary within between 
\begin_inset Formula $S[c_{0}...c_{2}]$
\end_inset

.
 i.e.
 there is no substring 
\begin_inset Formula $s$
\end_inset

 of length 
\begin_inset Formula $k$
\end_inset

 in the range 
\begin_inset Formula $S[c_{0}...c_{2}+k]$
\end_inset

 such that 
\begin_inset Formula $H(s)=1$
\end_inset

.
 (Equivalently, the basic chunking procedure will find 
\begin_inset Formula $c_{1},c_{2}$
\end_inset

 a if I start chunking from 
\begin_inset Formula $c_{1}$
\end_inset

 and set 
\begin_inset Formula $m=0$
\end_inset

)
\end_layout

\begin_layout Standard
Then, we claim that first thread will align with the second thread on either
 
\begin_inset Formula $c_{1}$
\end_inset

 or 
\begin_inset Formula $c_{2}$
\end_inset

 and so produce the same chunks after that.
\end_layout

\begin_layout Subsection*
Proof
\end_layout

\begin_layout Standard
Let 
\begin_inset Formula $b$
\end_inset

 the first thread's final chunk boundary such that 
\begin_inset Formula $b\le c_{1}$
\end_inset

.
\end_layout

\begin_layout Standard
Note that 
\begin_inset Formula $c_{1}-M\le b$
\end_inset

 as since the maximum chunk size is 
\begin_inset Formula $M$
\end_inset

.
\end_layout

\begin_layout Standard
There are 4 cases.
\end_layout

\begin_layout Paragraph*

\series bold
Case 1
\end_layout

\begin_layout Standard
If 
\begin_inset Formula $c_{1}-M<b\le c_{0}-m$
\end_inset

 , 
\end_layout

\begin_layout Standard
As 
\begin_inset Formula $b$
\end_inset

 is the last chunk boundary found by first thread where 
\begin_inset Formula $b\le c_{1}$
\end_inset

 then there must not be another chunk between 
\begin_inset Formula $c_{1}-M$
\end_inset

 and 
\begin_inset Formula $c_{0}$
\end_inset

 as that will be contradiction.
\end_layout

\begin_layout Standard
So since 
\begin_inset Formula $b+m\le c_{0}$
\end_inset

 , then 
\begin_inset Formula $c_{0}$
\end_inset

 must be next chunk boundary found.
 After which we have aligned with the second thread.
\end_layout

\begin_layout Paragraph*

\series bold
Case 2
\end_layout

\begin_layout Standard
If 
\begin_inset Formula $c_{0}-m<b\le c_{0}$
\end_inset

 .
 
\end_layout

\begin_layout Standard
The next chunk boundary found by first thread must be between 
\begin_inset Formula $b+m$
\end_inset

 and 
\begin_inset Formula $b+M$
\end_inset

.
\end_layout

\begin_layout Standard
From the case condition and condition 1, 
\begin_inset Formula $b+m\le c_{0}+m<c_{1}$
\end_inset


\end_layout

\begin_layout Standard
And from the case condition 
\begin_inset Formula $b+M>c_{1}$
\end_inset


\end_layout

\begin_layout Standard
So combining 
\begin_inset Formula $b+m<c_{1}<b+M$
\end_inset


\end_layout

\begin_layout Standard
Hence 
\begin_inset Formula $c_{1}$
\end_inset

 will be found by first thread.
\end_layout

\begin_layout Paragraph*

\series bold
Case 3
\end_layout

\begin_layout Standard
If 
\begin_inset Formula $c_{0}<b\le c_{1}-m$
\end_inset

.
 
\end_layout

\begin_layout Standard
As the next chunk boundary found by Thread 1 must be between 
\begin_inset Formula $b+m$
\end_inset

 and 
\begin_inset Formula $b+M$
\end_inset

,
\end_layout

\begin_layout Standard
We have 
\begin_inset Formula $b+m\le c_{1}$
\end_inset

 from the case condition.
\end_layout

\begin_layout Standard
and 
\begin_inset Formula $b+M>c_{0}+M>c_{1}$
\end_inset

 combining the case condition and that 
\begin_inset Formula $c_{1}-c_{0}\le M-m$
\end_inset

 from condition 1.
\end_layout

\begin_layout Standard
So combining 
\begin_inset Formula $b+m<c_{1}\le b+M$
\end_inset


\end_layout

\begin_layout Standard
As there are no other chunk boundaries from condition 2, 
\begin_inset Formula $c_{1}$
\end_inset

 must be found by the first thread.
\end_layout

\begin_layout Paragraph*

\series bold
Case 4
\end_layout

\begin_layout Standard
If 
\begin_inset Formula $c_{1}-m<b\le c_{1}$
\end_inset

.
 
\end_layout

\begin_layout Standard
As the next chunk boundary found by Thread 1 must be between 
\begin_inset Formula $b+m$
\end_inset

 and 
\begin_inset Formula $b+M$
\end_inset

,
\end_layout

\begin_layout Standard
We must have 
\begin_inset Formula $b+m<c_{2}$
\end_inset

 from the case condition and condition 1.
\end_layout

\begin_layout Standard
Also, 
\begin_inset Formula $b+M>c_{1}+M-m\ge c_{2}$
\end_inset

 combining the case condition and that 
\begin_inset Formula $c_{2}-c_{1}\le M-m$
\end_inset

 from condition 1.
\end_layout

\begin_layout Standard
So combining 
\begin_inset Formula $b+m<c_{2}\le b+M$
\end_inset


\end_layout

\begin_layout Standard
As there are no other chunk boundaries from condition 2, 
\begin_inset Formula $c_{2}$
\end_inset

 must be found by the first thread.
\end_layout

\begin_layout Section
Implementation Errors
\end_layout

\begin_layout Standard
Now this procedure assumes that the hashing procedure *always* operates
 on a consistent window of 
\begin_inset Formula $k$
\end_inset

 bytes.
 However, as it turns in our implementation this is not the case.
 Specifically the Rust Gear Hash implementation is streamed and combining
 with a common performance optimization of skipping 
\begin_inset Formula $m$
\end_inset

 bytes, we really have the following implementation:
\end_layout

\begin_layout LyX-Code
ChunkStart = 0
\end_layout

\begin_layout LyX-Code
HashStreamStart = 0
\end_layout

\begin_layout LyX-Code
while 
\begin_inset Formula $i<|S|:$
\end_inset


\end_layout

\begin_deeper
\begin_layout LyX-Code
if (
\begin_inset Formula $i$
\end_inset

 - ChunkStart 
\begin_inset Formula $\ge M$
\end_inset

) or (H(file[HashStreamStart...
\begin_inset Formula $i$
\end_inset

]) == 1):
\end_layout

\begin_deeper
\begin_layout LyX-Code
AddChunk(file[ChunkStart, i])
\end_layout

\begin_layout LyX-Code
ChunkStart = 
\begin_inset Formula $i$
\end_inset


\end_layout

\begin_layout LyX-Code
HashStreamStart = 
\begin_inset Formula $i+m$
\end_inset


\end_layout

\begin_layout LyX-Code
\begin_inset Formula $i=i+m$
\end_inset


\end_layout

\end_deeper
\begin_layout LyX-Code
\begin_inset Formula $i=i+1$
\end_inset


\end_layout

\end_deeper
\begin_layout LyX-Code
AddChunk(file[ChunkStart...])
\end_layout

\begin_layout Standard
Which has the odd side effect that for bytes 
\begin_inset Formula $m$
\end_inset

 to 
\begin_inset Formula $m+k$
\end_inset

 within a chunk we are hashing less than 
\begin_inset Formula $k$
\end_inset

 bytes.
 This means that in general, the hash output is 
\series bold
a function of the starting point of a chunk
\series default
, and can disagree on hash values for positions 
\begin_inset Formula $m$
\end_inset

 to 
\begin_inset Formula $m+k$
\end_inset

 of a chunk.
\end_layout

\begin_layout Standard
We can describe this using the following alternative notation for the hash
 function 
\begin_inset Formula $H.$
\end_inset


\end_layout

\begin_layout Standard
\begin_inset Formula $H(a,b)\rightarrow\{0,1\}|b>a+m$
\end_inset

 which is the output of the rolling hash chunking procedure on bytes 
\begin_inset Formula $S[a...b]$
\end_inset

.
 Note that this is still a rolling hash and its output in the usual case
 will depend only on the right-most 
\begin_inset Formula $k$
\end_inset

 bytes of the string 
\begin_inset Formula $S[a...b]$
\end_inset

.
 The implementation error above means that 
\begin_inset Formula $H(a_{1},b_{1})=H(a_{2},b_{1})$
\end_inset

 IFF 
\begin_inset Formula $m+k\le b_{1}-a_{1}$
\end_inset

 and 
\begin_inset Formula $m+k\le b_{2}-a_{2}$
\end_inset

.
\end_layout

\begin_layout Standard
Now, with this implementation, can we still perform parallel chunking?
\end_layout

\begin_layout Standard
I do not believe so.
 Due to the hash disagreement, under adverserial settings it is possible
 to construct two chunk sequences which will *never* align.
\end_layout

\end_body
\end_document